<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  <title>tango.io.File</title>
  <link href="./css/style.css" rel="stylesheet" type="text/css"/>
  <!-- <link href="./img/icon.png" rel="icon" type="image/png"/> -->
  <script type="text/javascript" src="./js/jquery.js"></script>
  <script type="text/javascript" src="./js/modules.js"></script>
  <script type="text/javascript" src="./js/quicksearch.js"></script>
  <script type="text/javascript" src="./js/navigation.js"></script>
  <!--<script type="text/javascript" src="./js/jquery.treeview.js"></script>-->
  <script type="text/javascript">
    var g_moduleFQN = "tango.io.File";
  </script>
  
</head>
<body>
<div id="content">
  <h1><a href="./htmlsrc/tango.io.File.html" class="symbol">tango.io.File</a></h1>
  
<p class="sec_header">License:</p>BSD style: see <a href="http://www.dsource.org/projects/tango/wiki/LibraryLicense">license.txt</a>
<p class="sec_header">Version:</p>Mar 2005: Initial release
<p class="sec_header">Version:</p>Feb 2007: No longer a proxy subclass
<p class="sec_header">Author:</p>Kris
<dl>
<dt class="decl">class <a class="symbol _class" name="File" href="./htmlsrc/tango.io.File.html#L37" kind="class" beg="37" end="146">File</a>; <a title="Permalink to this symbol" href="#File" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L37">#</a></dt>
<dd class="ddef">
<div class="summary">A wrapper atop of FileConduit to expose a simpler API. This one
        returns the entire file content as a void[], and sets the content
        to reflect a given void[].</div>
Method read() returns the current content of the file, whilst write()
        sets the file content, and file length, to the provided array. Method
        append() adds content to the tail of the file.
<p class="bl"/>
        Methods to inspect the file system, check the status of a file or
        directory and other facilities are made available via the associated
        path (exposed via the path() method)
<dl>
<dt class="decl"><a class="symbol _ctor" name="File.this" href="./htmlsrc/tango.io.File.html#L47" kind="ctor" beg="47" end="50">this</a><span class="params">(char[] <em>path</em>)</span>; <a title="Permalink to this symbol" href="#File.this" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L47">#</a></dt>
<dd class="ddef">
<div class="summary">Construct a File from a text string</div></dd>
<dt class="decl"><a class="symbol _ctor" name="File.this:2" href="./htmlsrc/tango.io.File.html#L58" kind="ctor" beg="58" end="61">this</a><span class="params">(PathView <em>path</em>)</span>; <span class="attrs">[<span class="stc">deprecated</span>]</span> <a title="Permalink to this symbol" href="#File.this:2" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L58">#</a></dt>
<dd class="ddef">
<div class="summary">Construct a File from the provided FilePath</div></dd>
<dt class="decl">File <a class="symbol _function" name="File.opCall" href="./htmlsrc/tango.io.File.html#L71" kind="function" beg="71" end="74">opCall</a><span class="params">(char[] <em>path</em>)</span>; <span class="attrs">[<span class="stc">static</span>]</span> <a title="Permalink to this symbol" href="#File.opCall" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L71">#</a></dt>
<dd class="ddef">
<div class="summary">Call-site shortcut to create a File instance. This 
                enables the same syntax as struct usage, so may expose
                a migration path</div></dd>
<dt class="decl">PathView <a class="symbol _function" name="File.path" href="./htmlsrc/tango.io.File.html#L82" kind="function" beg="82" end="85">path</a><span class="params">()</span>; <span class="attrs">[<span class="stc">final</span>, <span class="stc">deprecated</span>]</span> <a title="Permalink to this symbol" href="#File.path" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L82">#</a></dt>
<dd class="ddef">
<div class="summary">Return the path for this file instance</div></dd>
<dt class="decl">void[] <a class="symbol _function" name="File.read" href="./htmlsrc/tango.io.File.html#L93" kind="function" beg="93" end="107">read</a><span class="params">()</span>; <span class="attrs">[<span class="stc">final</span>]</span> <a title="Permalink to this symbol" href="#File.read" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L93">#</a></dt>
<dd class="ddef">
<div class="summary">Return the content of the file.</div></dd>
<dt class="decl">File <a class="symbol _function" name="File.write" href="./htmlsrc/tango.io.File.html#L115" kind="function" beg="115" end="118">write</a><span class="params">(void[] <em>content</em>)</span>; <span class="attrs">[<span class="stc">final</span>]</span> <a title="Permalink to this symbol" href="#File.write" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L115">#</a></dt>
<dd class="ddef">
<div class="summary">Set the file content and length to reflect the given array.</div></dd>
<dt class="decl">File <a class="symbol _function" name="File.append" href="./htmlsrc/tango.io.File.html#L126" kind="function" beg="126" end="129">append</a><span class="params">(void[] <em>content</em>)</span>; <span class="attrs">[<span class="stc">final</span>]</span> <a title="Permalink to this symbol" href="#File.append" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L126">#</a></dt>
<dd class="ddef">
<div class="summary">Append content to the file.</div></dd>
<dt class="decl">File <a class="symbol _function" name="File.write:2" href="./htmlsrc/tango.io.File.html#L137" kind="function" beg="137" end="145">write</a><span class="params">(void[] <em>content</em>, FileConduit.Style <em>style</em>)</span>; <span class="attrs">[<span class="prot">private</span>]</span> <a title="Permalink to this symbol" href="#File.write:2" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.File.html#L137">#</a></dt>
<dd class="ddef">
<div class="summary">Set the file content and length to reflect the given array.</div></dd></dl></dd></dl>
</div>
<div id="footer">
  <p>Copyright (c) 2004 Kris Bell. All rights reserved</p>
  <p>Page generated by <a href="http://code.google.com/p/dil">dil</a> on Fri Dec 26 04:03:58 2008. Rendered by <a href="http://code.google.com/p/dil/wiki/Kandil">kandil</a>.</p>
</div>
</body>
</html>